API Documentation
Resource.h
1 // Resource.h
3 //
5 
6 namespace nkGraphics
7 {
11  class DLL_GRAPHICS_EXPORT Resource
12  {
13  public :
14 
18  Resource () ;
28  virtual ~Resource () ;
29 
30  // Getters
34  bool isReadyForRendering () const ;
38  bool isUnloaded () const ;
58  bool getHidden () const ;
62  bool getGpuUploadCanBeDeferred () const ;
63 
64  // Setters
70  virtual void setResourcePath (const nkMemory::StringView& path) ;
83  void setHidden (bool value) ;
98  void setGpuUploadCanBeDeferred (bool value) ;
99 
100  // Loading
113  virtual bool load () = 0 ;
117  virtual void unload () = 0 ;
118  } ;
119 }
nkGraphics::Resource::isUnloaded
bool isUnloaded() const
nkGraphics::Resource::~Resource
virtual ~Resource()
nkGraphics::Resource::getLoadState
RESOURCE_LOAD_STATE getLoadState() const
nkGraphics::RESOURCE_TYPE
RESOURCE_TYPE
The type of resources available in the component.
Definition: ResourceType.h:12
nkGraphics::Resource::Resource
Resource(const nkMemory::StringView &path)
nkGraphics::Resource::isReadyForRendering
bool isReadyForRendering() const
nkGraphics::Resource::setGpuUploadCanBeDeferred
void setGpuUploadCanBeDeferred(bool value)
nkGraphics::Resource::getGpuUploadCanBeDeferred
bool getGpuUploadCanBeDeferred() const
nkGraphics::Resource::getResourceName
nkMemory::StringView getResourceName() const
nkGraphics::RESOURCE_LOAD_STATE
RESOURCE_LOAD_STATE
The resource load states possible.
Definition: ResourceLoadState.h:12
nkGraphics::Resource::setResourcePath
virtual void setResourcePath(const nkMemory::StringView &path)
nkGraphics::Resource::load
virtual bool load()=0
nkGraphics::Resource::getResourcePath
nkMemory::StringView getResourcePath() const
nkGraphics::Resource::getHidden
bool getHidden() const
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkGraphics::Resource::getResourceTypeName
RESOURCE_TYPE getResourceTypeName() const
nkGraphics::Resource
Base class for a resource in the component.
Definition: Resource.h:12
nkGraphics::Resource::unload
virtual void unload()=0
nkGraphics::Resource::setHidden
void setHidden(bool value)
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::Resource::Resource
Resource()
nkGraphics::Resource::setResourceName
void setResourceName(const nkMemory::StringView &name)